Resource {id} | Mars OS REST APIs

Resource /webmapi/luns/{id}Expand | Collapse

APIs for logical storage volumes

Get a specific LUN instance

Description

Get a specific LUN instance

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

GET /webmapi/luns/{id}

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<LunInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LUN_SHOW_LUN_NOT_FOUND	27068	LUN not found.

Produces

application/json

Since

1.0

DELETE /webmapi/luns/{id}

Destroy a LUN

Description

Destroy a LUN

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

DELETE /webmapi/luns/{id}?force=param0

Query Parameters:

forceForces the operation (required=false, default=false).

Format: ?force={true|false}

Example: ?force=true

True will forcefully perform the operation. Default is false.

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LUN_DESTROY_LUN_NOT_FOUND	27046	LUN not found.
LUN_DESTROY_LUN_MAPPED_AND_ONLINE	27048	LUN is mapped and online.
LUN_DESTROY_INTERNAL_ERROR	27049	Internal error: unable to fetch LUN information.
LUN_DESTROY_SNAPS_EXIST	27050	LUN has snapshots.
LUN_DESTROY_LUN_ONLINE_FAILED	27051	Internal error bringing LUN online.
LUN_DESTROY_LUN_OFFLINE_FAILED	27052	Internal error taking LUN offline.
LUN_DESTROY_DISCARDED	27053	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/{id}/action/offline

Take a LUN offline

Description

Take a LUN offline

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

PUT /webmapi/luns/{id}/action/offline

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LUN_OFFLINE_LUN_NOT_FOUND	27000	LUN not found.
LUN_OFFLINE_LUN_ALREADY_OFFLINE	27001	LUN is already offline.
LUN_OFFLINE_DISCARDED	27003	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/{id}/action/online

Bring a LUN online

Description

Bring a LUN online

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

PUT /webmapi/luns/{id}/action/online

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LUN_ONLINE_LUN_NOT_FOUND	27023	LUN not found.
LUN_ONLINE_LUN_ALREADY_ONLINE	27024	LUN is already online.
LUN_ONLINE_DISCARDED	27026	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/luns/{id}/maps

Display a set of LUN maps given the options provided

Description

Display a set of LUN maps given the options provided

Maps are the initiator groups to which the LUN is mapped. If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

GET /webmapi/luns/{id}/maps

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<LunMapInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LUN_MAP_SHOW_LUN_NOT_FOUND	27069	LUN not found.
LUN_MAP_SHOW_IGROUP_NOT_FOUND	27070	Initiator group not found.
LUN_MAP_SHOW_TOO_MANY_OPTIONS_SPECIFIED	27071	Too many options specified.

Produces

application/json

Since

1.0